<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pymsn.event.conversation.ConversationEventInterface</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://telepathy.freedesktop.org/wiki/Pymsn">pymsn</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;pymsn ::
        <a href="pymsn.event-module.html">Package&nbsp;event</a> ::
        <a href="pymsn.event.conversation-module.html">Module&nbsp;conversation</a> ::
        Class&nbsp;ConversationEventInterface
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ConversationEventInterface</h1><p class="nomargin-top"><span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface">source&nbsp;code</a></span></p>
<pre class="base-tree">
        object --+    
                 |    
<a href="pymsn.event.BaseEventInterface-class.html">BaseEventInterface</a> --+
                     |
                    <strong class="uidshort">ConversationEventInterface</strong>
</pre>

<hr />
<p>interfaces allowing the user to get notified about events from a <a 
  href="pymsn.conversation.ConversationInterface-class.html" 
  class="link">Conversation</a> object.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pymsn.event.conversation.ConversationEventInterface-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">conversation</span>)</span><br />
      Initializer</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pymsn.event.conversation.ConversationEventInterface-class.html#on_conversation_state_changed" class="summary-sig-name">on_conversation_state_changed</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">state</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_state_changed">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pymsn.event.conversation.ConversationEventInterface-class.html#on_conversation_error" class="summary-sig-name">on_conversation_error</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>,
        <span class="summary-sig-arg">error</span>)</span><br />
      Called when an error occurs in the <code class="link">Client</code>.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_error">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pymsn.event.conversation.ConversationEventInterface-class.html#on_conversation_user_joined" class="summary-sig-name">on_conversation_user_joined</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">contact</span>)</span><br />
      Called when a user joins the conversation.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_user_joined">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pymsn.event.conversation.ConversationEventInterface-class.html#on_conversation_user_left" class="summary-sig-name">on_conversation_user_left</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">contact</span>)</span><br />
      Called when a user leaved the conversation.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_user_left">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pymsn.event.conversation.ConversationEventInterface-class.html#on_conversation_user_typing" class="summary-sig-name">on_conversation_user_typing</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">contact</span>)</span><br />
      Called when a user is typing.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_user_typing">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pymsn.event.conversation.ConversationEventInterface-class.html#on_conversation_message_received" class="summary-sig-name">on_conversation_message_received</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">sender</span>,
        <span class="summary-sig-arg">message</span>)</span><br />
      Called when a user sends a message.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_message_received">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pymsn.event.conversation.ConversationEventInterface-class.html#on_conversation_nudge_received" class="summary-sig-name">on_conversation_nudge_received</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">sender</span>)</span><br />
      Called when a user sends a nudge.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_nudge_received">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">conversation</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Initializer</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>conversation</code></strong> (<a href="pymsn.conversation.ConversationInterface-class.html" 
          class="link">Conversation</a>) - the conversation we want to be notified for its events</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="on_conversation_state_changed"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">on_conversation_state_changed</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">state</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_state_changed">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
  </dl>
<div class="fields">      <p><strong>Attention:</strong>
        not implemented
      </p>
</div></td></tr></table>
</div>
<a name="on_conversation_error"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">on_conversation_error</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">type</span>,
        <span class="sig-arg">error</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_error">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when an error occurs in the <code 
  class="link">Client</code>.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>type</code></strong> (<a href="pymsn.event.client.ClientErrorType-class.html" 
          class="link">ClientErrorType</a>) - the error type</li>
        <li><strong class="pname"><code>error</code></strong> (<a href="pymsn.gnet.constants.IoError-class.html" 
          class="link">NetworkError</a> or <a 
          href="pymsn.event.client.AuthenticationError-class.html" 
          class="link">AuthenticationError</a> or <a 
          href="pymsn.event.client.ProtocolError-class.html" 
          class="link">ProtocolError</a> or <a 
          href="pymsn.event.conversation.ContactInviteError-class.html" 
          class="link">ContactInviteError</a> or <a 
          href="pymsn.event.conversation.MessageError-class.html" 
          class="link">MessageError</a>) - the error code</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="on_conversation_user_joined"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">on_conversation_user_joined</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">contact</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_user_joined">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a user joins the conversation.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>contact</code></strong> (<a href="pymsn.profile.Contact-class.html" 
          class="link">Contact</a>) - the contact whose presence changed</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="on_conversation_user_left"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">on_conversation_user_left</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">contact</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_user_left">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a user leaved the conversation.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>contact</code></strong> (<a href="pymsn.profile.Contact-class.html" 
          class="link">Contact</a>) - the contact whose presence changed</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="on_conversation_user_typing"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">on_conversation_user_typing</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">contact</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_user_typing">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a user is typing.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>contact</code></strong> (<a href="pymsn.profile.Contact-class.html" 
          class="link">Contact</a>) - the contact whose presence changed</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="on_conversation_message_received"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">on_conversation_message_received</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">sender</span>,
        <span class="sig-arg">message</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_message_received">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a user sends a message.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>sender</code></strong> (<a href="pymsn.profile.Contact-class.html" 
          class="link">Contact</a>) - the contact who sent the message</li>
        <li><strong class="pname"><code>message</code></strong> (<a href="pymsn.conversation.ConversationMessage-class.html" 
          class="link">ConversationMessage</a>) - the message</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="on_conversation_nudge_received"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">on_conversation_nudge_received</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">sender</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pymsn.event.conversation-pysrc.html#ConversationEventInterface.on_conversation_nudge_received">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a user sends a nudge.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>sender</code></strong> (<a href="pymsn.profile.Contact-class.html" 
          class="link">Contact</a>) - the contact who sent the nudge</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://telepathy.freedesktop.org/wiki/Pymsn">pymsn</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Aug  2 15:19:16 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
